Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Huddle for Alonzo #4778

Merged
merged 6 commits into from
Dec 6, 2024
Merged

Huddle for Alonzo #4778

merged 6 commits into from
Dec 6, 2024

Conversation

aniketd
Copy link
Contributor

@aniketd aniketd commented Nov 28, 2024 •
edited
Loading

Description

  • Alonzo: Switch to using Huddle/Cuddle.
    • Remove
      • crypto.cddl
      • extras.cddl
    • Add
      • Test.Cardano.Ledger.Alonzo.CDDL
      • cardano-ledger-alonzo:exe:huddle-cddle
      • huddleRoundTrip(Ann)CborSpec for all definitions already being tested
    • Autogenerate alonzo.cddl using Huddle/Cuddle
    • Update
      • hie.yaml with alonzo paths module and huddle-cddl
      • gen-cddl.sh to include alonzo
  • Mary: Refactor. Add comments. Backport MIR
  • Allegra: Refactor. Add comments. Backport MIR
  • Shelley: Refactor. Add comments. Backport MIR.
    • Backport move_instantaneous_reward.
    • Add delta_coin.
    • Reorganise the exports such that only the previous era CDDL needs to be imported in a following era to be overridden by explicitly hiding definitions.
  • Add bounded_bytes to core CDDL. Switch to heredoc.
    • We switch to heredoc for comments because it has a quasiquoter that preserves leading whitespace, namely [str||].

Resolves #4769

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated
  • All visible changes are prepended to the latest section of a CHANGELOG.md for the affected packages.
    New section is never added with the code changes. (See RELEASING.md)
  • When applicable, versions are updated in .cabal and CHANGELOG.md files according to the
    versioning process.
  • The version bounds in .cabal files for all affected packages are updated.
    If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)
  • Code is formatted with fourmolu (use scripts/fourmolize.sh)
  • Cabal files are formatted (use scripts/cabal-format.sh)
  • hie.yaml has been updated (use scripts/gen-hie.sh)
  • Self-reviewed the diff

@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch 2 times, most recently from ea9c930 to d4fb77d Compare November 29, 2024 13:10
@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch 4 times, most recently from 1786e19 to 72f406d Compare December 3, 2024 16:31
@aniketd aniketd marked this pull request as ready for review December 3, 2024 16:41
@aniketd aniketd requested a review from a team as a code owner December 3, 2024 16:41
@aniketd aniketd mentioned this pull request Dec 3, 2024
Merged
9 tasks
@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch from 72f406d to 54b6dca Compare December 4, 2024 14:06
teodanciu
teodanciu reviewed Dec 4, 2024
View reviewed changes
Copy link
Contributor

@teodanciu teodanciu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome that you improved the previous era with the comments!
I have a few questions so far, will have a bit later another careful look at the alonzo.cddl differences.

eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs Show resolved Hide resolved
eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs Show resolved Hide resolved
eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs Outdated Show resolved Hide resolved
eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs Outdated Show resolved Hide resolved
eras/allegra/impl/cddl-files/allegra.cddl Show resolved Hide resolved
eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs Show resolved Hide resolved
eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/CDDL.hs Show resolved Hide resolved
eras/shelley/impl/test/Test/Cardano/Ledger/Shelley/Binary/CddlSpec.hs Outdated Show resolved Hide resolved
eras/alonzo/impl/test/Test/Cardano/Ledger/Alonzo/Binary/CddlSpec.hs Show resolved Hide resolved
@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch from 54b6dca to caa7d5c Compare December 5, 2024 09:37
@aniketd aniketd requested a review from teodanciu December 5, 2024 09:38
@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch from caa7d5c to a410380 Compare December 6, 2024 13:47
teodanciu
teodanciu approved these changes Dec 6, 2024
View reviewed changes
Copy link
Contributor

@teodanciu teodanciu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Looks good to me

@aniketd
Add bounded_bytes to core CDDL. Switch to heredoc.
5c8aa3c 
We switch to heredoc for comments because it has a quasiquoter that
preserves leading whitespace, namely `[str||]`.
@aniketd
CDDL:shelley: Refactor. Add comments. Backport MIR.
3974571 
Backport `move_instantaneous_reward`.
Add `delta_coin`.

Reorganise the exports such that only the previous era CDDL needs to be
imported in a following era to be overridden by explicitly hiding
definitions.
@aniketd
CDDL:allegra: Refactor. Add comments. Backport MIR
3547cda
@aniketd
CDDL:mary: Refactor. Add comments. Backport MIR
b8eb09d
@aniketd
CDDL:alonzo: Switch to using Huddle/Cuddle.
885a510 
- Remove
  - crypto.cddl
  - extras.cddl
- Add
  - Test.Cardano.Ledger.Alonzo.CDDL
  - cardano-ledger-alonzo:exe:huddle-cddle
  - huddleRoundTrip(Ann)CborSpec for all definitions already being tested
- Autogenerate alonzo.cddl using Huddle/Cuddle
- Update
  - hie.yaml with alonzo paths module and huddle-cddl
  - gen-cddl.sh to include alonzo
@aniketd
Update conway.cddl with new comments
730df0c
@aniketd aniketd force-pushed the aniketd/huddle-alonzo branch from a410380 to 730df0c Compare December 6, 2024 16:23
@aniketd aniketd enabled auto-merge December 6, 2024 16:23
@aniketd aniketd merged commit f8b21d7 into master Dec 6, 2024
153 of 154 checks passed
@aniketd aniketd deleted the aniketd/huddle-alonzo branch December 6, 2024 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teodanciu teodanciu teodanciu approved these changes

@neilmayhew neilmayhew Awaiting requested review from neilmayhew

@nc6 nc6 Awaiting requested review from nc6

@Lucsanszky Lucsanszky Awaiting requested review from Lucsanszky

@Soupstraw Soupstraw Awaiting requested review from Soupstraw

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Alonzo: Generate CDDL using Huddle/Cuddle
3 participants
@aniketd @teodanciu @Soupstraw